lib Fix Part 3/6 – Object related methods by graphemecluster · Pull Request #50451 · microsoft/TypeScript

graphemecluster · 2022-08-25T18:24:44Z

General Information

PR separated out from #49855, because there might be some members expecting smaller PRs. As mentioned in the comments from the big PR, whether to review a single, large PR or 6 smaller PRs is up to the TypeScript Team to decide. I couldn't have found a better way for this; hopefully this will not bring any trouble to the Team.

This PR partially fixes #49773.
For details and the track list about the changes, please see #49773.

Part 3/6, Object related methods

Fix #31175
Fix #24509 as a side-effect

🟠 Breaking Change

Quoted from #49773:

Per the spec, these methods start with either a ToObject or RequireObjectCoercible operation, which throws a TypeError with a nullish value. Starting from TypeScript 4.8 with #49119, {} now precisely represents any nullish value. Thus, the first parameter of these methods should now be typed {} to prevent runtime errors.

sandersn · 2022-09-13T23:52:21Z

@typescript-bot run dt
@typescript-bot test top100
@typescript-bot user test this

typescript-bot · 2022-09-13T23:52:23Z

Heya @sandersn, I've started to run the parallelized Definitely Typed test suite on this PR at 8b640be. You can monitor the build here.

typescript-bot · 2022-09-13T23:52:23Z

Heya @sandersn, I've started to run the diff-based user code test suite on this PR at 8b640be. You can monitor the build here.

Update: The results are in!

typescript-bot · 2022-09-13T23:52:23Z

Heya @sandersn, I've started to run the diff-based top-repos suite on this PR at 8b640be. You can monitor the build here.

Update: The results are in!

typescript-bot · 2022-09-14T00:12:51Z

@sandersn Here are the results of running the user test suite comparing main and refs/pull/50451/merge:

Something interesting changed - please have a look.

Details

graceful-fs

/mnt/ts_downloads/graceful-fs/tsconfig.json

[NEW] error TS2339: Property '__proto__' does not exist on type '{}'.
- /mnt/ts_downloads/graceful-fs/node_modules/graceful-fs/clone.js(6,14)

webpack

tsconfig.json

[NEW] error TS2345: Argument of type 'A' is not assignable to parameter of type 'object'.
- lib/index.js#L83
- lib/index.js#L89

tsconfig.types.json

[NEW] error TS2345: Argument of type '{ url: string; } & Writable<{ chunk: Chunk | undefined; filename: string; contentHash: string | false; }>' is not assignable to parameter of type 'PathData | undefined'.
- lib/SourceMapDevToolPlugin.js#L482
[NEW] error TS2345: Argument of type 'B' is not assignable to parameter of type '{}'.
- lib/index.js#L78
[NEW] error TS2345: Argument of type 'A' is not assignable to parameter of type 'object'.
- lib/index.js#L83
- lib/index.js#L89
[NEW] error TS2345: Argument of type 'T' is not assignable to parameter of type '{}'.
- lib/util/deprecation.js#L220
[NEW] error TS2322: Type 'Readonly<Writable<{ _fakeHook: true; }>>' is not assignable to type 'FakeHook<T>'.
- lib/util/deprecation.js#L261
[MISSING] error TS2345: Argument of type '{ url: string; } & { chunk: Chunk | undefined; filename: string; contentHash: string | false; }' is not assignable to parameter of type 'PathData | undefined'.
- lib/SourceMapDevToolPlugin.js#L482
[MISSING] error TS2322: Type 'Readonly<{ _fakeHook: true; }>' is not assignable to type 'FakeHook<T>'.
- lib/util/deprecation.js#L261

typescript-bot · 2022-09-14T01:52:30Z

@sandersn Here are the results of running the top-repos suite comparing main and refs/pull/50451/merge:

Something interesting changed - please have a look.

Details

conwnet/github1s

2 of 4 projects failed to build with the old tsc and were ignored

extensions/github1s/tsconfig.json

error TS2322: Type '((route: string, options?: RequestParameters | undefined) => Promise<OctokitResponse<any, number> | undefined>) & Writable<RequestInterface<object>>' is not assignable to type 'RequestInterface<object>'.
- extensions/github1s/src/adapters/github1s/fetcher.ts#L87
error TS2322: Type '((query: string, parameters?: RequestParameters | undefined) => Promise<unknown>) & Writable<graphql>' is not assignable to type 'graphql'.
- extensions/github1s/src/adapters/github1s/fetcher.ts#L100

microsoft/vscode

3 of 54 projects failed to build with the old tsc and were ignored

test/smoke/tsconfig.json

error TS2322: Type 'Writable<any>' is not assignable to type 'ApplicationOptions'.
error TS2740: Type 'Writable<any>' is missing the following properties from type 'ApplicationOptions': quality, workspacePath, userDataDir, extensionsPath, and 3 more.
- test/smoke/src/areas/workbench/data-loss.test.ts#L214

neoclide/coc.nvim

tsconfig.json

error TS2739: Type 'Writable<any>' is missing the following properties from type 'FileChange': root, subscription, files
- src/core/watchman.ts#L116

TanStack/query

9 of 12 projects failed to build with the old tsc and were ignored

packages/query-broadcast-client-experimental/tsconfig.lint.json

error TS2345: Argument of type 'unknown' is not assignable to parameter of type 'object'.
- packages/query-core/src/infiniteQueryBehavior.ts#L30 in packages/query-core/tsconfig.json
- packages/query-core/src/query.ts#L374 in packages/query-core/tsconfig.json

packages/react-query-devtools/tsconfig.lint.json

error TS2345: Argument of type 'unknown' is not assignable to parameter of type 'object'.
- packages/query-core/src/infiniteQueryBehavior.ts#L30 in packages/query-core/tsconfig.json
- packages/query-core/src/query.ts#L374 in packages/query-core/tsconfig.json

vercel/hyper

2 of 3 projects failed to build with the old tsc and were ignored

tsconfig.json

error TS2345: Argument of type '{ cwd: string; splitDirection: undefined; shell: string; shellArgs: string[]; } & Writable<any> & Writable<{ uid: string; }>' is not assignable to parameter of type 'SessionOptions'.
- app/ui/window.ts#L157 in app/tsconfig.json

vercel/swr

3 of 10 projects failed to build with the old tsc and were ignored

_internal/tsconfig.json

error TS2769: No overload matches this call.
- _internal/utils/config-context.ts#L75
error TS2322: Type 'Writable<any>' is not assignable to type 'FullConfiguration'.
- _internal/utils/config.ts#L48
- _internal/utils/use-swr-config.ts#L8

core/tsconfig.json

error TS2769: No overload matches this call.
- _internal/utils/config-context.ts#L75
error TS2322: Type 'Writable<any>' is not assignable to type 'FullConfiguration'.
- _internal/utils/config.ts#L48
- _internal/utils/use-swr-config.ts#L8

immutable/tsconfig.json

error TS2769: No overload matches this call.
- _internal/utils/config-context.ts#L75
error TS2322: Type 'Writable<any>' is not assignable to type 'FullConfiguration'.
- _internal/utils/config.ts#L48
- _internal/utils/use-swr-config.ts#L8

infinite/tsconfig.json

error TS2769: No overload matches this call.
- _internal/utils/config-context.ts#L75
error TS2322: Type 'Writable<any>' is not assignable to type 'FullConfiguration'.
- _internal/utils/config.ts#L48
- _internal/utils/use-swr-config.ts#L8

mutation/tsconfig.json

error TS2769: No overload matches this call.
- _internal/utils/config-context.ts#L75
error TS2322: Type 'Writable<any>' is not assignable to type 'FullConfiguration'.
- _internal/utils/config.ts#L48
- _internal/utils/use-swr-config.ts#L8

test/tsconfig.json

error TS2769: No overload matches this call.
- _internal/utils/config-context.ts#L75
error TS2322: Type 'Writable<any>' is not assignable to type 'FullConfiguration'.
- _internal/utils/config.ts#L48
- _internal/utils/use-swr-config.ts#L8

test/type/tsconfig.json

error TS2769: No overload matches this call.
- _internal/utils/config-context.ts#L75
error TS2322: Type 'Writable<any>' is not assignable to type 'FullConfiguration'.
- _internal/utils/config.ts#L48
- _internal/utils/use-swr-config.ts#L8

graphemecluster · 2022-11-09T02:09:09Z

Great, TypeScript bug discovered! (Temporarily fixed with a non-null assertion)

ExE-Boss · 2023-02-22T18:41:30Z

src/lib/es5.d.ts

+    isSealed(o: object): boolean;
+
+    /**
+     * Returns true if existing property attributes cannot be modified in an object and new properties cannot be added to the object.
+     * @param o Object to test.
+     */
+    isSealed(o: any): true;
+
+    /**
+     * Returns true if existing property attributes and values cannot be modified in an object, and new properties cannot be added to the object.
+     * @param o Object to test.
+     */
+    isFrozen(o: object): boolean;

    /**
     * Returns true if existing property attributes and values cannot be modified in an object, and new properties cannot be added to the object.
     * @param o Object to test.
     */
-    isFrozen(o: any): boolean;
+    isFrozen(o: any): true;

    /**
     * Returns a value that indicates whether new properties can be added to an object.
     * @param o Object to test.
     */
-    isExtensible(o: any): boolean;
+    isExtensible(o: object): boolean;
+
+    /**
+     * Returns a value that indicates whether new properties can be added to an object.
+     * @param o Object to test.
+     */
+    isExtensible(o: any): false;


These changes are not actually correct, as object is a subtype of any, and thus, a variable that is a union of object and non‑object will cause the second overload to be selected.

wchargin · 2024-05-13T15:14:20Z

Hi, is it possible to revisit this stalled PR, specifically for Object.hasOwn? I have some callers that would like to pass o: string | SomeObjectType, which is sound and would be allowed by this PR but is not allowed as of v5.4.5. I see that there was an objection to changes to the is* methods; could we maybe separate out the other, noncontroversial changes into their own PR so that they can be merged?

lib Types and Documentations Fix

8b640be

typescript-bot added the For Backlog Bug PRs that fix a backlog bug label Aug 25, 2022

graphemecluster mentioned this pull request Aug 25, 2022

lib Types and Documentations Fix #49855

Closed

sandersn self-assigned this Sep 13, 2022

sandersn requested review from DanielRosenwasser and sandersn September 13, 2022 23:50

Merge main branch: Array line number changes

0d84b05

graphemecluster changed the title ~~lib Types and Documentations Fix, Part 3/6~~ lib Fix Part 3/6 – Object related methods Oct 9, 2022

graphemecluster added 3 commits October 11, 2022 20:13

Merge main branch: Array line number changes

8fa2cff

Merge remote-tracking branch 'upstream/main' into implement49733-part3

cb3493e

TypeScript bug discovered

65bbb0c

Merge remote-tracking branch 'upstream/main' into implement49733-part3

0926e64

ExE-Boss reviewed Feb 22, 2023

View reviewed changes

wchargin mentioned this pull request May 13, 2024

A list of suggested update to TypeScript's lib #49773

Closed

27 tasks

Conversation

graphemecluster commented Aug 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

General Information

Part 3/6, Object related methods

Uh oh!

sandersn commented Sep 13, 2022

Uh oh!

typescript-bot commented Sep 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Sep 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Sep 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Sep 14, 2022

/mnt/ts_downloads/graceful-fs/tsconfig.json

Uh oh!

typescript-bot commented Sep 14, 2022

Uh oh!

graphemecluster commented Nov 9, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wchargin commented May 13, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

graphemecluster commented Aug 25, 2022 •

edited

Loading

typescript-bot commented Sep 13, 2022 •

edited

Loading

typescript-bot commented Sep 13, 2022 •

edited

Loading

typescript-bot commented Sep 13, 2022 •

edited

Loading